API

Procurement APIs

POST system/api/api-operations/100248

See AOP/100248

HTTP method POST
URI https://api.rambase.net/system/api/api-operations/100248
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 200
API resource identifier 2344, version 3

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<Parameters>
2
     <SerialNumber
SerialNumber

Required/mandatory field

Serial number

>
{String}</SerialNumber>
3
     <GoodsReceptionItem
GoodsReceptionItem

Goods reception reference

This field is optional.

>
4
          <Database
Database

Company code/database the object belongs to

This field is optional.

>
{String}</Database>
5
          <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

This field is optional.

>
{Integer}</GoodsReceptionItemId>
6
          <GoodsReception
GoodsReception

This field is optional.

>
7
               <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

This field is optional.

>
{Integer}</GoodsReceptionId>
8
          </GoodsReception>
9
     </GoodsReceptionItem>
10
</Parameters>
1
{
2
     "parameters": {
3
          "serialNumber
SerialNumber

Required/mandatory field

Serial number

":
"{String}",
4
          "goodsReceptionItem
GoodsReceptionItem

Goods reception reference

This field is optional.

":
{
5
               "database
Database

Company code/database the object belongs to

This field is optional.

":
"{String}",
6
               "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

This field is optional.

":
"{Integer}",
7
               "goodsReception
GoodsReception

This field is optional.

":
{
8
                    "goodsReceptionId
GoodsReceptionId

Goods reception identifier

This field is optional.

":
"{Integer}"
9
               }
10
          }
11
     }
12
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 101420 HTTP 404 Setting definition not found
Error 101515 HTTP 400 Value for setting {0} already exists
Error 101718 HTTP 400 Maximum value for this setting is {0}
Error 102475 HTTP 400 The number of serial numbers from {0} can't exceed {1} which is the quantity linked to this goods reception
Error 101209 HTTP 404 Goods transfer item not found
Error 100242 HTTP 404 Stock correction not found
Error 102466 HTTP 400 Serial number can't be selected because the customer document is not linked to the provided goods reception
Error 102389 HTTP 400 All the serial numbers are entered
Error 102446 HTTP 400 Serial number is registered from before